STAAD.Pro Help

OS. Python向けのOpenSTAAD API構文の解釈

OpenSTAADのドキュメントに記載された関数は、C++構文で記述されています。これらをPythonプログラムで使用するために解釈するプロセスは一般に簡単です。

クラスとメソッド

クラスの構文はOSClassUI::Methodの形式でリストされています。Pythonでは、代わりにClass.Methodとして指定する必要があります。

例では、"os"という変数を使用してOpenSTAADをインスタンス化しました。その後、os.Classの形式を使用してクラスを呼び出しています(たとえば、Geometryクラスはos.Geometryを使用して参照されています)。ドキュメントで使用しているC++構文では"OSClassUI"となっていますが、Pythonでは代わりに"Class"を使用します。

この例外は"ルート"のOpenSTAAD関数で、それらではOpenSTAADのインスタンス化に使用した任意の変数が使用されます(同じ例ではos.GetBaseUnit)。つまり、OpenSTAADオブジェクトはこれらの関数のクラスとして機能します。

注記: Pythonでは、_FlagAsMethod関数を使用して、それぞれのOpenSTAADメソッドをメソッドとして一度識別する必要があります。

戻り値

構文のリストでは、関数に戻り値があるかを先頭の"VARIANT"で示しています。これは単に、通常は変数に格納される値を関数が返すことを意味します。構文のリストで先頭に"void"が付いている場合、その関数に戻り値はありません。

注記: 関数の戻り値を関数のパラメータに格納される値と混同しないでください。

変数とパラメータ

構文のリストでは、パラメータのタイプが"VARIANT FAR"と示されていますが、これは必ずしも役立ちません。

それよりも、どのタイプの変数を使用するか("string""long"など)を示すパラメータの説明を確認することが重要です。Pythonでは、変数のタイプを宣言する必要はなく、値が解釈されるときに決定されます。それでも、変数を別の関数で使用するときは、文字列と数値のどちらが格納されているかやどのタイプの数値が格納されているかが問題になります。OpenSTAADで返すことができるのは、整数または浮動小数点の小数点位置です。